Orders | Equinix Product Documentation

Retrieve an order

Request

This method retrieves an order by its ID for a user with permission to view this request.

Security

BearerAuth

Path

orderIdstring, [ 1 .. 100 ] charactersrequired

Identifier of the Order

Query

ibxsArray of strings

List of IBXs to be filtered

Example:ibxs=SG1

Payload

// No request payload

Responses

Ok

Bodyapplication/json

orderIdstring, [ 1 .. 100 ] characters

Unique identifier of the order.

accountNamestring

Customer account name

accountNumberstring

Customer account number

quoteRequestTypestring

The request type of the quote

Enum:"NEW""AMENDMENT""PAPERWORK""REPLACEMENT_RENEWAL""TERMINATION""MIGRATION"

contactsArray of objects(Contacts)

The related party associated with the ticket.

statusstring

The current status of the order or service

Enum:"RECEIVED""IN_PROGRESS""ON_HOLD""CLOSED""CANCELLED"

createdDateTimestring, (date-time)

The order created date and time in UTC timezone.

updatedDateTimestring, (date-time)

The order updated date and time in UTC timezone.

closedDateTimestring, (date-time)

The order closed date and time in UTC timezone.

estimatedCompletionDateTimestring, (date-time)

The estimated completion date and time in UTC timezone

currencyCodestring(currencyCode)

ISO-4217 currency code

Enum:"AED""AFN""ALL""AMD""ANG""AOA""ARS""AUD""AWG""AZN"

channelstring

Type of channel used to place the order

Enum:"API""PORTAL""MOBILE""OFFLINE"

subChannelstring

Type of sub-channel used to place the order

Enum:"ECP""ECX""IX""NE""EMG""QUOTE"

notesArray of objects(Note)

The notes that are associated to the orders.

additionalInfoArray of objects(Additional product details)

This section is reserved to display product specific information

Example:

[
  {
    "key": "ASSET_ID",
    "value": "4-89137987923"
  },
  {
    "key": "SERIAL_NUMBER",
    "value": "232891719"
  }
]

customerReferenceIdstring, [ 5 .. 100 ] characters

Customer Reference Number / External Reference Number

cancellableboolean

When true, order can be cancelled.

Default:false

modifiableboolean

When true, order can be modified.

Default:false

detailsArray of objects(ordersLine)

Response

[
  {
    "orderId": "1-100000000001",
    "accountName": "EQUNIX",
    "accountNumber": "100001",
    "quoteRequestType": "NEW",
    "contacts": [ … ],
    "status": "CLOSED",
    "createdDateTime": "2020-07-31T11:23:06.000Z",
    "updatedDateTime": "2020-08-06T05:29:26.000Z",
    "channel": "API",
    "details": [ … ]
  }
]